home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / include / websrvcs / nsISOAPBlock.h < prev    next >
Encoding:
C/C++ Source or Header  |  2006-05-08  |  10.9 KB  |  286 lines
  1. /*
  2.  * DO NOT EDIT.  THIS FILE IS GENERATED FROM nsISOAPBlock.idl
  3.  */
  4.  
  5. #ifndef __gen_nsISOAPBlock_h__
  6. #define __gen_nsISOAPBlock_h__
  7.  
  8.  
  9. #ifndef __gen_nsISupports_h__
  10. #include "nsISupports.h"
  11. #endif
  12.  
  13. /* For IDL files that don't want to include root IDL files. */
  14. #ifndef NS_NO_VTABLE
  15. #define NS_NO_VTABLE
  16. #endif
  17. class nsIDOMElement; /* forward declaration */
  18.  
  19. class nsIVariant; /* forward declaration */
  20.  
  21. class nsISOAPEncoding; /* forward declaration */
  22.  
  23. class nsISchemaType; /* forward declaration */
  24.  
  25. class nsISOAPAttachments; /* forward declaration */
  26.  
  27.  
  28. /* starting interface:    nsISOAPBlock */
  29. #define NS_ISOAPBLOCK_IID_STR "843afaa8-1dd2-11b2-8b0d-9b5d16fe64ea"
  30.  
  31. #define NS_ISOAPBLOCK_IID \
  32.   {0x843afaa8, 0x1dd2, 0x11b2, \
  33.     { 0x8b, 0x0d, 0x9b, 0x5d, 0x16, 0xfe, 0x64, 0xea }}
  34.  
  35. /**
  36.  * This interface encapsulates an arbitrary block to be used
  37.  * by the soap serialization or protocol.  It presents the
  38.  * namespaceURI, name, encoding, schemaType, and value of the
  39.  * block.  There are two different ways this may be used:
  40.  * <p>1.  When created by a user for serialization, a value is set
  41.  * which is then used to encode the message.  In this case, the
  42.  * user sets the value (or element in the case of a literal
  43.  * block) which is then encoded (unless it is the element) 
  44.  * and incorporated into the document as it is encoded.
  45.  * <p>2.  When requested by the user from a message that is to
  46.  * be decoded.  In this case, an element is set on the block
  47.  * which is automatically decoded whenever the value attribute is
  48.  * accessed (possibly after the user sets the encoding or schemaType,
  49.  * or for literal blocks, the user just accesses the element and
  50.  * no decoding is performed.  For SOAP which attachments, hidden 
  51.  * attachments may also be associated from the message to the block 
  52.  * so that later decoding which relies on the attachments is possible.
  53.  */
  54. class NS_NO_VTABLE nsISOAPBlock : public nsISupports {
  55.  public: 
  56.  
  57.   NS_DEFINE_STATIC_IID_ACCESSOR(NS_ISOAPBLOCK_IID)
  58.  
  59.   /**
  60.    *  Initialize the block for additional decoding information.
  61.    *
  62.    * @param aAttachments Attachments in case this refers to them.
  63.    *
  64.    * @param aVersion SOAP version for decoding special header attributes.
  65.    */
  66.   /* void init (in nsISOAPAttachments aAttachments, in unsigned short aVersion); */
  67.   NS_IMETHOD Init(nsISOAPAttachments *aAttachments, PRUint16 aVersion) = 0;
  68.  
  69.   /**
  70.    *  The namespace URI of the block.  Ignored if name is null.
  71.    *  If this is modified, element is set to null and all 
  72.    *  attributes computed from element revert to previous
  73.    *  uncomputed values.  If element is set, this becomes computed.
  74.    */
  75.   /* attribute AString namespaceURI; */
  76.   NS_IMETHOD GetNamespaceURI(nsAString & aNamespaceURI) = 0;
  77.   NS_IMETHOD SetNamespaceURI(const nsAString & aNamespaceURI) = 0;
  78.  
  79.   /**
  80.    * The name of the block. If the block is left unnamed, it
  81.    * will be encoded using the element types defined in the SOAP-ENC
  82.    * schema. For example, <code><SOAP-ENC:int>45</SOAP-ENC:int>
  83.    * </code>.  If this is modified, element is set to null and all 
  84.    * attributes computed from element revert to previous uncomputed
  85.    * values.  If element is set, this becomes computed.
  86.    */
  87.   /* attribute AString name; */
  88.   NS_IMETHOD GetName(nsAString & aName) = 0;
  89.   NS_IMETHOD SetName(const nsAString & aName) = 0;
  90.  
  91.   /**
  92.    * The encoding that was / will be applied to the
  93.    * block.  If this is blank and element is non-null,
  94.    * it becomes impossible to decode the block when
  95.    * the value is requested.
  96.    */
  97.   /* attribute nsISOAPEncoding encoding; */
  98.   NS_IMETHOD GetEncoding(nsISOAPEncoding * *aEncoding) = 0;
  99.   NS_IMETHOD SetEncoding(nsISOAPEncoding * aEncoding) = 0;
  100.  
  101.   /**
  102.    * The schema type used to encode or decode the
  103.    *   block.  If this is null, then the default
  104.    *   encoder or decoder may 
  105.    */
  106.   /* attribute nsISchemaType schemaType; */
  107.   NS_IMETHOD GetSchemaType(nsISchemaType * *aSchemaType) = 0;
  108.   NS_IMETHOD SetSchemaType(nsISchemaType * aSchemaType) = 0;
  109.  
  110.   /**
  111.    *  The element which is the encoded value of this block.
  112.    *  If this is set, value, namespaceURI, and name becomes a 
  113.    *  computed attributes which are produced by decoding this 
  114.    *  element.
  115.    */
  116.   /* attribute nsIDOMElement element; */
  117.   NS_IMETHOD GetElement(nsIDOMElement * *aElement) = 0;
  118.   NS_IMETHOD SetElement(nsIDOMElement * aElement) = 0;
  119.  
  120.   /**
  121.    *  The native value which is the decoded value of 
  122.    *  this block.  If this is modified, element is set
  123.    *  to null and all attributes computed from element 
  124.    *  revert to previous uncomputed values.  If element 
  125.    *  is set, this becomes computed, relying on the 
  126.    *  value of encoding and schemaType each time it is 
  127.    *  computed.
  128.    */
  129.   /* attribute nsIVariant value; */
  130.   NS_IMETHOD GetValue(nsIVariant * *aValue) = 0;
  131.   NS_IMETHOD SetValue(nsIVariant * aValue) = 0;
  132.  
  133. };
  134.  
  135. /* Use this macro when declaring classes that implement this interface. */
  136. #define NS_DECL_NSISOAPBLOCK \
  137.   NS_IMETHOD Init(nsISOAPAttachments *aAttachments, PRUint16 aVersion); \
  138.   NS_IMETHOD GetNamespaceURI(nsAString & aNamespaceURI); \
  139.   NS_IMETHOD SetNamespaceURI(const nsAString & aNamespaceURI); \
  140.   NS_IMETHOD GetName(nsAString & aName); \
  141.   NS_IMETHOD SetName(const nsAString & aName); \
  142.   NS_IMETHOD GetEncoding(nsISOAPEncoding * *aEncoding); \
  143.   NS_IMETHOD SetEncoding(nsISOAPEncoding * aEncoding); \
  144.   NS_IMETHOD GetSchemaType(nsISchemaType * *aSchemaType); \
  145.   NS_IMETHOD SetSchemaType(nsISchemaType * aSchemaType); \
  146.   NS_IMETHOD GetElement(nsIDOMElement * *aElement); \
  147.   NS_IMETHOD SetElement(nsIDOMElement * aElement); \
  148.   NS_IMETHOD GetValue(nsIVariant * *aValue); \
  149.   NS_IMETHOD SetValue(nsIVariant * aValue); 
  150.  
  151. /* Use this macro to declare functions that forward the behavior of this interface to another object. */
  152. #define NS_FORWARD_NSISOAPBLOCK(_to) \
  153.   NS_IMETHOD Init(nsISOAPAttachments *aAttachments, PRUint16 aVersion) { return _to Init(aAttachments, aVersion); } \
  154.   NS_IMETHOD GetNamespaceURI(nsAString & aNamespaceURI) { return _to GetNamespaceURI(aNamespaceURI); } \
  155.   NS_IMETHOD SetNamespaceURI(const nsAString & aNamespaceURI) { return _to SetNamespaceURI(aNamespaceURI); } \
  156.   NS_IMETHOD GetName(nsAString & aName) { return _to GetName(aName); } \
  157.   NS_IMETHOD SetName(const nsAString & aName) { return _to SetName(aName); } \
  158.   NS_IMETHOD GetEncoding(nsISOAPEncoding * *aEncoding) { return _to GetEncoding(aEncoding); } \
  159.   NS_IMETHOD SetEncoding(nsISOAPEncoding * aEncoding) { return _to SetEncoding(aEncoding); } \
  160.   NS_IMETHOD GetSchemaType(nsISchemaType * *aSchemaType) { return _to GetSchemaType(aSchemaType); } \
  161.   NS_IMETHOD SetSchemaType(nsISchemaType * aSchemaType) { return _to SetSchemaType(aSchemaType); } \
  162.   NS_IMETHOD GetElement(nsIDOMElement * *aElement) { return _to GetElement(aElement); } \
  163.   NS_IMETHOD SetElement(nsIDOMElement * aElement) { return _to SetElement(aElement); } \
  164.   NS_IMETHOD GetValue(nsIVariant * *aValue) { return _to GetValue(aValue); } \
  165.   NS_IMETHOD SetValue(nsIVariant * aValue) { return _to SetValue(aValue); } 
  166.  
  167. /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
  168. #define NS_FORWARD_SAFE_NSISOAPBLOCK(_to) \
  169.   NS_IMETHOD Init(nsISOAPAttachments *aAttachments, PRUint16 aVersion) { return !_to ? NS_ERROR_NULL_POINTER : _to->Init(aAttachments, aVersion); } \
  170.   NS_IMETHOD GetNamespaceURI(nsAString & aNamespaceURI) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetNamespaceURI(aNamespaceURI); } \
  171.   NS_IMETHOD SetNamespaceURI(const nsAString & aNamespaceURI) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetNamespaceURI(aNamespaceURI); } \
  172.   NS_IMETHOD GetName(nsAString & aName) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetName(aName); } \
  173.   NS_IMETHOD SetName(const nsAString & aName) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetName(aName); } \
  174.   NS_IMETHOD GetEncoding(nsISOAPEncoding * *aEncoding) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetEncoding(aEncoding); } \
  175.   NS_IMETHOD SetEncoding(nsISOAPEncoding * aEncoding) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetEncoding(aEncoding); } \
  176.   NS_IMETHOD GetSchemaType(nsISchemaType * *aSchemaType) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetSchemaType(aSchemaType); } \
  177.   NS_IMETHOD SetSchemaType(nsISchemaType * aSchemaType) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetSchemaType(aSchemaType); } \
  178.   NS_IMETHOD GetElement(nsIDOMElement * *aElement) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetElement(aElement); } \
  179.   NS_IMETHOD SetElement(nsIDOMElement * aElement) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetElement(aElement); } \
  180.   NS_IMETHOD GetValue(nsIVariant * *aValue) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetValue(aValue); } \
  181.   NS_IMETHOD SetValue(nsIVariant * aValue) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetValue(aValue); } 
  182.  
  183. #if 0
  184. /* Use the code below as a template for the implementation class for this interface. */
  185.  
  186. /* Header file */
  187. class nsSOAPBlock : public nsISOAPBlock
  188. {
  189. public:
  190.   NS_DECL_ISUPPORTS
  191.   NS_DECL_NSISOAPBLOCK
  192.  
  193.   nsSOAPBlock();
  194.  
  195. private:
  196.   ~nsSOAPBlock();
  197.  
  198. protected:
  199.   /* additional members */
  200. };
  201.  
  202. /* Implementation file */
  203. NS_IMPL_ISUPPORTS1(nsSOAPBlock, nsISOAPBlock)
  204.  
  205. nsSOAPBlock::nsSOAPBlock()
  206. {
  207.   /* member initializers and constructor code */
  208. }
  209.  
  210. nsSOAPBlock::~nsSOAPBlock()
  211. {
  212.   /* destructor code */
  213. }
  214.  
  215. /* void init (in nsISOAPAttachments aAttachments, in unsigned short aVersion); */
  216. NS_IMETHODIMP nsSOAPBlock::Init(nsISOAPAttachments *aAttachments, PRUint16 aVersion)
  217. {
  218.     return NS_ERROR_NOT_IMPLEMENTED;
  219. }
  220.  
  221. /* attribute AString namespaceURI; */
  222. NS_IMETHODIMP nsSOAPBlock::GetNamespaceURI(nsAString & aNamespaceURI)
  223. {
  224.     return NS_ERROR_NOT_IMPLEMENTED;
  225. }
  226. NS_IMETHODIMP nsSOAPBlock::SetNamespaceURI(const nsAString & aNamespaceURI)
  227. {
  228.     return NS_ERROR_NOT_IMPLEMENTED;
  229. }
  230.  
  231. /* attribute AString name; */
  232. NS_IMETHODIMP nsSOAPBlock::GetName(nsAString & aName)
  233. {
  234.     return NS_ERROR_NOT_IMPLEMENTED;
  235. }
  236. NS_IMETHODIMP nsSOAPBlock::SetName(const nsAString & aName)
  237. {
  238.     return NS_ERROR_NOT_IMPLEMENTED;
  239. }
  240.  
  241. /* attribute nsISOAPEncoding encoding; */
  242. NS_IMETHODIMP nsSOAPBlock::GetEncoding(nsISOAPEncoding * *aEncoding)
  243. {
  244.     return NS_ERROR_NOT_IMPLEMENTED;
  245. }
  246. NS_IMETHODIMP nsSOAPBlock::SetEncoding(nsISOAPEncoding * aEncoding)
  247. {
  248.     return NS_ERROR_NOT_IMPLEMENTED;
  249. }
  250.  
  251. /* attribute nsISchemaType schemaType; */
  252. NS_IMETHODIMP nsSOAPBlock::GetSchemaType(nsISchemaType * *aSchemaType)
  253. {
  254.     return NS_ERROR_NOT_IMPLEMENTED;
  255. }
  256. NS_IMETHODIMP nsSOAPBlock::SetSchemaType(nsISchemaType * aSchemaType)
  257. {
  258.     return NS_ERROR_NOT_IMPLEMENTED;
  259. }
  260.  
  261. /* attribute nsIDOMElement element; */
  262. NS_IMETHODIMP nsSOAPBlock::GetElement(nsIDOMElement * *aElement)
  263. {
  264.     return NS_ERROR_NOT_IMPLEMENTED;
  265. }
  266. NS_IMETHODIMP nsSOAPBlock::SetElement(nsIDOMElement * aElement)
  267. {
  268.     return NS_ERROR_NOT_IMPLEMENTED;
  269. }
  270.  
  271. /* attribute nsIVariant value; */
  272. NS_IMETHODIMP nsSOAPBlock::GetValue(nsIVariant * *aValue)
  273. {
  274.     return NS_ERROR_NOT_IMPLEMENTED;
  275. }
  276. NS_IMETHODIMP nsSOAPBlock::SetValue(nsIVariant * aValue)
  277. {
  278.     return NS_ERROR_NOT_IMPLEMENTED;
  279. }
  280.  
  281. /* End of implementation class template. */
  282. #endif
  283.  
  284.  
  285. #endif /* __gen_nsISOAPBlock_h__ */
  286.